Sample Workflow
A high-level workflow example in the REST API client is provided in this section.
Some basic operations you can perform with the REST API client include:
> Logging in to an HSM or partition directly or remotely,
>PED authentication and operation,
>Automation of services running with the REST API,
>Configuration and management of the appliance and other elements,
>Basic auditing and tracking, and
>Connection testing.
Each tab in the user interface contains corresponding resources and an output window at the bottom for tracking and parsing query results. For more complex or custom resource queries, a Custom IO tab is also included.
NOTE Detailed structural information and schemata of the resources referenced in this document can be found in the REST API Command Reference documentation.
Getting Started
Figure 1: Workflow
1.Choose Raw IO or Formatted IO from the output window at the bottom of the client to view the records of your requests and responses according to your preference.
•Raw IO shows you your request input and output result. It turns green when a query is successful, and red when unsuccessful.
•Formatted IO only shows the output result from your query, in an organized formatted view.
2.Login to your appliance to authenticate to the REST API. Depending on your permissions and what you wish to do with the REST API, you may also have to login to an HSM or partition.
3.Set your preferences for using the REST API in the Options tab.
4.Perform operations with your appliance, HSM (or partition), or services by using commands from their respective tabs.
•Appliance tab: If you are not logged in to an HSM or partition, your commands are limited to configuration and logging from the Appliance tab.
•Commands tab: Handles HSM or partition operations. If you are using PED-based authentication, connect to your PED. HSM or partition command control will be passed to the PED.
•Service tab: If you are running any services alongside the REST API, commands to configure, start, stop, and set global preferences for them will be found here.
5.If you want to automate some parts of your operations with the REST API, use or create a macro instruction file in the Macros tab. Similarly, if you want to keep a log of steps you complete in a long process so that you can refer to it later, having a macro file is useful.
6.Once you become familiar with the fundamental resources available in the REST API client, use the Custom IO tab to customize your requests or input resources not available as client buttons.
NOTE A complete list of resources you can query with the REST API can be found in the REST API Command Reference documentation.
